Skip to content

module: improve typescript error message format #57687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

module: improve typescript error message format #57687

wants to merge 2 commits into from

Conversation

@marco-ippolito
Copy link
Member

@marco-ippolito marco-ippolito commented Mar 30, 2025

Unfortunately the automation deleted my commit #57598
TIL dont push on dep update automation or the next sunday it will be overwritten 😆

Fixes: #56830

This PR improves the error messages generated by the transpiler.

Node.js v23.9.0:

marcoippolito@marcos-MacBook-Pro node % node --input-type=commonjs-typescript -p "enum Foo"
node:internal/modules/typescript:69
        throw new ERR_INVALID_TYPESCRIPT_SYNTAX(error.message);
        ^

SyntaxError [ERR_INVALID_TYPESCRIPT_SYNTAX]:   x Expected '{', got '<eof>'
   ,----
 1 | enum Foo
   :      ^^^
   `----

    at parseTypeScript (node:internal/modules/typescript:69:15)
    at processTypeScriptCode (node:internal/modules/typescript:129:42)
    at stripTypeScriptModuleTypes (node:internal/modules/typescript:196:22)
    at parseAndEvalCommonjsTypeScript (node:internal/process/execution:369:26)
    at node:internal/main/eval_string:71:3 {
  code: 'ERR_INVALID_TYPESCRIPT_SYNTAX'
}

This PR:

marcoippolito@marcos-MacBook-Pro node % ./node --input-type=commonjs-typescript -p "enum Foo"
[eval]:1   
        
     enum Foo
          ^^^
        
SyntaxError [ERR_INVALID_TYPESCRIPT_SYNTAX]: Expected '{', got '<eof>'
    at parseTypeScript (node:internal/modules/typescript:71:36)
    at processTypeScriptCode (node:internal/modules/typescript:145:42)
    at stripTypeScriptModuleTypes (node:internal/modules/typescript:212:22)
    at parseAndEvalCommonjsTypeScript (node:internal/process/execution:375:26)
    at node:internal/main/eval_string:71:3 {
  code: 'ERR_INVALID_TYPESCRIPT_SYNTAX'
}

It removes the internal file path:

node:internal/modules/typescript:69
        throw new ERR_INVALID_TYPESCRIPT_SYNTAX(error.message);

Removes the padding boxing the message:

   ,----
 1 | enum Foo
   :      ^^^
   `----

In general it blends better with Node.js error style.
There is still an improvement to make that involves removing the whitespace around:

        
     enum Foo
          ^^^

This depends from SWC and its currently being fixed.

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 30, 2025

Review requested:

  • @nodejs/loaders
  • @nodejs/security-wg
  • @nodejs/typescript

@nodejs-github-bot nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Mar 30, 2025
@marco-ippolito marco-ippolito mentioned this pull request Mar 30, 2025
Closed
@marco-ippolito marco-ippolito added the strip-types Issues or PRs related to strip-types support label Mar 30, 2025
@codecov
Copy link

codecov bot commented Mar 30, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.23%. Comparing base (af75d04) to head (9fb2f5f).
Report is 734 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #57687   +/-   ##
=======================================
  Coverage   90.23%   90.23%           
=======================================
  Files         630      630           
  Lines      185055   185073   +18     
  Branches    36221    36221           
=======================================
+ Hits       166984   167009   +25     
+ Misses      11043    11036    -7     
  Partials     7028     7028
Files with missing lines Coverage Δ
lib/internal/modules/typescript.js 97.51% <100.00%> (+0.17%) ⬆️
lib/internal/process/execution.js 94.81% <100.00%> (+0.02%) ⬆️

... and 29 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 30, 2025

CI: https://ci.nodejs.org/job/node-test-pull-request/65897/

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 30, 2025

CI: https://ci.nodejs.org/job/node-test-pull-request/65898/

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 30, 2025

CI: https://ci.nodejs.org/job/node-test-pull-request/65899/

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 31, 2025

CI: https://ci.nodejs.org/job/node-test-pull-request/65901/

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 31, 2025

CI: https://ci.nodejs.org/job/node-test-pull-request/65903/

@marco-ippolito
Copy link
Member Author

marco-ippolito commented Mar 31, 2025 •
edited
Loading

Windows ofc 😫

---
duration_ms: 5506.172
exitcode: 1
severity: fail
stack: |-
  Test failure: 'the error message should not contain extra padding'
  Location: test\es-module\test-typescript-eval.mjs:268:1
  AssertionError [ERR_ASSERTION]: Expected values to be strictly equal:
  + actual - expected

  + '[eval]:1   \r'
  - '[eval]:1   '
                ^

      at TestContext.<anonymous> (file:///C:/workspace/node-test-binary-windows-js-suites/node/test/es-module/test-typescript-eval.mjs:276:3)
      at process.processTicksAndRejections (node:internal/process/task_queues:105:5)
      at async Test.run (node:internal/test_runner/test:1063:7)
      at async Test.processPendingSubtests (node:internal/test_runner/test:746:7) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: '[eval]:1   \r',
    expected: '[eval]:1   ',
    operator: 'strictEqual'
  }
...

aduh95
aduh95 approved these changes Mar 31, 2025
View reviewed changes
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 31, 2025

CI: https://ci.nodejs.org/job/node-test-pull-request/65910/

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 31, 2025

CI: https://ci.nodejs.org/job/node-test-pull-request/65911/

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Apr 1, 2025

CI: https://ci.nodejs.org/job/node-test-pull-request/65914/

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Apr 1, 2025

CI: https://ci.nodejs.org/job/node-test-pull-request/65915/

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Apr 1, 2025

CI: https://ci.nodejs.org/job/node-test-pull-request/65916/

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Apr 1, 2025

CI: https://ci.nodejs.org/job/node-test-pull-request/65918/

@marco-ippolito marco-ippolito added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. labels Apr 1, 2025
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 1, 2025
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Apr 1, 2025

Landed in 0d91070...1c2d98d

nodejs-github-bot added a commit that referenced this pull request Apr 1, 2025
@nodejs-github-bot
deps: update amaro to 0.5.0
e5ff731 
PR-URL: #57687
Fixes: #56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
nodejs-github-bot pushed a commit that referenced this pull request Apr 1, 2025
@marco-ippolito @nodejs-github-bot
module: improve typescript error message format
1c2d98d 
PR-URL: #57687
Fixes: #56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
JonasBa pushed a commit to JonasBa/node that referenced this pull request Apr 11, 2025
@nodejs-github-bot @JonasBa
deps: update amaro to 0.5.0
95de31a 
PR-URL: nodejs#57687
Fixes: nodejs#56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
JonasBa pushed a commit to JonasBa/node that referenced this pull request Apr 11, 2025
@marco-ippolito @JonasBa
module: improve typescript error message format
bac2483 
PR-URL: nodejs#57687
Fixes: nodejs#56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
RafaelGSS pushed a commit that referenced this pull request May 1, 2025
@nodejs-github-bot @RafaelGSS
deps: update amaro to 0.5.0
0729bbc 
PR-URL: #57687
Fixes: #56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
RafaelGSS pushed a commit that referenced this pull request May 1, 2025
@marco-ippolito @RafaelGSS
module: improve typescript error message format
6cacc36 
PR-URL: #57687
Fixes: #56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
@RafaelGSS RafaelGSS mentioned this pull request May 1, 2025
Merged
RafaelGSS pushed a commit that referenced this pull request May 2, 2025
@nodejs-github-bot @RafaelGSS
deps: update amaro to 0.5.0
a561755 
PR-URL: #57687
Fixes: #56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
RafaelGSS pushed a commit that referenced this pull request May 2, 2025
@marco-ippolito @RafaelGSS
module: improve typescript error message format
1e490aa 
PR-URL: #57687
Fixes: #56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
@marco-ippolito marco-ippolito added the backport-open-v22.x Indicate that the PR has an open backport label Jun 25, 2025
marco-ippolito added a commit to marco-ippolito/node that referenced this pull request Jun 25, 2025
@marco-ippolito
module: improve typescript error message format
bb8bf48 
PR-URL: nodejs#57687
Fixes: nodejs#56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
marco-ippolito pushed a commit to marco-ippolito/node that referenced this pull request Jun 25, 2025
@nodejs-github-bot @marco-ippolito
deps: update amaro to 0.5.0
d06fba6 
PR-URL: nodejs#57687
Fixes: nodejs#56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
marco-ippolito added a commit to marco-ippolito/node that referenced this pull request Jul 3, 2025
@marco-ippolito
module: improve typescript error message format
fbbac0c 
PR-URL: nodejs#57687
Fixes: nodejs#56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
marco-ippolito pushed a commit to marco-ippolito/node that referenced this pull request Jul 3, 2025
@nodejs-github-bot @marco-ippolito
deps: update amaro to 0.5.0
43b598f 
PR-URL: nodejs#57687
Fixes: nodejs#56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
marco-ippolito added a commit to marco-ippolito/node that referenced this pull request Jul 3, 2025
@marco-ippolito
module: improve typescript error message format
8c22513 
PR-URL: nodejs#57687
Fixes: nodejs#56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
marco-ippolito pushed a commit to marco-ippolito/node that referenced this pull request Jul 3, 2025
@nodejs-github-bot @marco-ippolito
deps: update amaro to 0.5.0
85b1802 
PR-URL: nodejs#57687
Fixes: nodejs#56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
@marco-ippolito marco-ippolito added backport-open-v22.x Indicate that the PR has an open backport and removed backport-open-v22.x Indicate that the PR has an open backport labels Jul 3, 2025
marco-ippolito added a commit that referenced this pull request Jul 4, 2025
@marco-ippolito
module: improve typescript error message format
975ac22 
PR-URL: #57687
Backport-PR-URL: #57298
Fixes: #56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
PR-URL: #56350
Fixes: nodejs/typescript#17
marco-ippolito pushed a commit that referenced this pull request Jul 4, 2025
@nodejs-github-bot @marco-ippolito
deps: update amaro to 0.5.0
5e16b80 
PR-URL: #57687
Backport-PR-URL: #57298
Fixes: #56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
PR-URL: #56350
Fixes: nodejs/typescript#17
@marco-ippolito marco-ippolito added backported-to-v22.x PRs backported to the v22.x-staging branch. and removed backport-open-v22.x Indicate that the PR has an open backport labels Jul 4, 2025
RafaelGSS pushed a commit that referenced this pull request Jul 15, 2025
@marco-ippolito @RafaelGSS
module: improve typescript error message format
fe7994e 
PR-URL: #57687
Backport-PR-URL: #57298
Fixes: #56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
PR-URL: #56350
Fixes: nodejs/typescript#17
RafaelGSS pushed a commit that referenced this pull request Jul 15, 2025
@nodejs-github-bot @RafaelGSS
deps: update amaro to 0.5.0
25f8682 
PR-URL: #57687
Backport-PR-URL: #57298
Fixes: #56830
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
PR-URL: #56350
Fixes: nodejs/typescript#17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@legendecas legendecas legendecas approved these changes

@aduh95 aduh95 aduh95 approved these changes

@RafaelGSS RafaelGSS RafaelGSS approved these changes

Assignees

No one assigned

Labels

backported-to-v22.x PRs backported to the v22.x-staging branch. commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. strip-types Issues or PRs related to strip-types support

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Provide more information when there is a SyntaxError

5 participants

@marco-ippolito @nodejs-github-bot @legendecas @aduh95 @RafaelGSS